Class Document

سند

یک سند، حاوی یک یا چند شی Tab ، که هر کدام حاوی متن غنی و عناصری مانند جداول و لیست است.

ممکن است اسناد با استفاده از DocumentApp باز یا ایجاد شوند.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

روش‌هایی در کلاس Document که مستقیماً به محتوای متن دسترسی پیدا می‌کنند و آن‌ها را تغییر می‌دهند، بر روی برگه فعال (در اسکریپت‌های متصل به یک سند خاص) یا تب اول (اگر یک برگه فعال در دسترس نباشد) عمل می‌کنند. اسکریپت های متکی به این روش ها (مثلا getBody() ) را می توان با استفاده از getTabs() و سپس Tab.asDocumentTab() به برگه ها پشتیبانی کرد.

روش ها

روش نوع برگشت شرح مختصر
addBookmark(position) Bookmark یک Bookmark در Position داده شده به برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
addEditor(emailAddress) Document کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند.
addEditor(user) Document کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند.
addEditors(emailAddresses) Document آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند.
addFooter() FooterSection یک بخش پاورقی، اگر وجود نداشته باشد، به اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
addHeader() HeaderSection یک بخش سرصفحه، اگر وجود نداشته باشد، به اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
addNamedRange(name, range) NamedRange NamedRange را اضافه می‌کند، که Range است که دارای نام و شناسه‌ای است که برای بازیابی بعدی، در برگه اول یا برای اسکریپت‌هایی که به یک سند متصل شده‌اند ، در برگه فعال استفاده می‌کند.
addViewer(emailAddress) Document کاربر داده شده را به لیست بینندگان Document اضافه می کند.
addViewer(user) Document کاربر داده شده را به لیست بینندگان Document اضافه می کند.
addViewers(emailAddresses) Document آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند.
getActiveTab() Tab Tab فعال فعلی کاربر را در سند دریافت می کند.
getAs(contentType) Blob محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند.
getBlob() Blob محتویات Document فعلی را به صورت لکه ای بازیابی می کند.
getBody() Body Body اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، DocumentBodySection برگه فعال را بازیابی می کند.
getBookmark(id) Bookmark Bookmark با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
getBookmarks() Bookmark[] همه اشیاء Bookmark در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
getCursor() Position نشانگر کاربر را در برگه فعال دریافت می کند.
getEditors() User[] لیست ویرایشگران این Document را دریافت می کند.
getFooter() FooterSection بخش پاورقی برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش پاورقی برگه فعال را بازیابی می کند.
getFootnotes() Footnote[] تمام عناصر Footnote در بدنه اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، بدنه برگه فعال را بازیابی می کند.
getHeader() HeaderSection بخش هدر برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش سربرگ برگه فعال را بازیابی می کند.
getId() String شناسه منحصر به فرد سند را بازیابی می کند.
getLanguage() String کد زبان سند را دریافت می کند.
getName() String عنوان سند را بازیابی می کند.
getNamedRangeById(id) NamedRange NamedRange با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
getNamedRanges() NamedRange[] تمام اشیاء NamedRange را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
getNamedRanges(name) NamedRange[] تمام اشیاء NamedRange را با نام داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
getSelection() Range انتخاب کاربر را در برگه فعال دریافت می کند.
getSupportedLanguageCodes() String[] همه کدهای زبانی که در فایل‌های Google Docs پشتیبانی می‌شوند را دریافت می‌کند.
getTab(tabId) Tab Tab با شناسه مشخص شده دریافت می کند.
getTabs() Tab[] همه Tab تودرتو نشده را که بخشی از سند هستند دریافت می کند.
getUrl() String URL را برای دسترسی به سند فعلی بازیابی می کند.
getViewers() User[] لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند.
newPosition(element, offset) Position یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص در برگه اول یا، برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال است.
newRange() RangeBuilder سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه در اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، از برگه فعال استفاده می شود.
removeEditor(emailAddress) Document کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند.
removeEditor(user) Document کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند.
removeViewer(emailAddress) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند.
removeViewer(user) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند.
saveAndClose() void Document فعلی را ذخیره می کند.
setActiveTab(tabId) void Tab انتخاب شده کاربر در سند فعلی را به برگه با شناسه مشخص شده تنظیم می کند.
setCursor(position) Document مکان نما کاربر را با یک Position تعیین می کند.
setLanguage(languageCode) Document کد زبان سند را تنظیم می کند.
setName(name) Document عنوان سند را تنظیم می کند.
setSelection(range) Document انتخاب کاربر را در برگه فعال با توجه به Range تنظیم می کند.

مستندات دقیق

addBookmark(position)

یک Bookmark در Position داده شده به برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن نشانک به هر برگه، از روش DocumentTab.addBookmark(position) استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

پارامترها

نام تایپ کنید توضیحات
position Position موقعیت نشانک جدید.

بازگشت

Bookmark - نشانک جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای افزودن

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
emailAddresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

یک بخش پاورقی، اگر وجود نداشته باشد، به اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن بخش پاورقی به هر برگه، از متد DocumentTab.addFooter() استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

بازگشت

FooterSection - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

یک بخش سرصفحه، اگر وجود نداشته باشد، به اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن یک بخش هدر به هر تب، از متد DocumentTab.addHeader() استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

بازگشت

HeaderSection - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

NamedRange را اضافه می‌کند، که Range است که دارای نام و شناسه‌ای است که برای بازیابی بعدی، در برگه اول یا برای اسکریپت‌هایی که به یک سند متصل شده‌اند ، در برگه فعال استفاده می‌کند. برای افزودن NamedRange در هر برگه، از روش DocumentTab.addNamedRange(name, range) استفاده کنید. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک سند می توانند یک نام مشترک داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها در سند منحصر به فرد هستند، مانند شناسه در HTML. پس از افزودن NamedRange به یک سند، نمی‌توانید آن را تغییر دهید، فقط می‌توانید آن را حذف کنید.

هر اسکریپتی که به سند دسترسی داشته باشد می تواند به NamedRange دسترسی داشته باشد. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لازم نیست منحصر به فرد باشد. نام محدوده باید بین 1 تا 256 کاراکتر باشد.
range Range محدوده عناصری که باید با نام مرتبط شوند. محدوده می تواند انتخاب فعال ، یک نتیجه جستجو ، یا به صورت دستی با newRange() ساخته شود.

بازگشت

NamedRange - NamedRange .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

کاربر داده شده را به لیست بینندگان Document اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای افزودن

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

کاربر داده شده را به لیست بینندگان Document اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
emailAddresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

Tab فعال فعلی کاربر را در سند دریافت می کند. یک اسکریپت فقط می‌تواند به برگه فعال کاربری که اسکریپت را اجرا می‌کند دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل شده باشد.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

بازگشت

Tab - Tab فعال کاربر در حال حاضر، یا اگر اسکریپت به سند محدود نشده باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

پارامترها

نام تایپ کنید توضیحات
contentType String نوع MIME برای تبدیل؛ 'application/pdf' و 'text/markdown' پشتیبانی می شوند.

بازگشت

Blob - سند فعلی به عنوان یک لکه.

getBlob()

محتویات Document فعلی را به صورت لکه ای بازیابی می کند.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

بازگشت

Blob - سند فعلی به عنوان یک لکه.

getBody()

Body اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، DocumentBodySection برگه فعال را بازیابی می کند. برای دریافت DocumentBodySection هر برگه، از متد DocumentTab.getBody() استفاده کنید.

برگه ها ممکن است شامل انواع مختلفی از بخش ها باشند (به عنوان مثال، HeaderSection ، FooterSection ). بخش فعال یک برگه Body است.

روش های عنصر در Document به Body فعال تفویض می شود.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

بازگشت

Body - بخش بدنه زبانه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

Bookmark با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت نشانک در هر برگه، از روش DocumentTab.getBookmark(id) استفاده کنید. اگر چنین Bookmark در برگه وجود نداشته باشد، این روش null را برمی‌گرداند. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

پارامترها

نام تایپ کنید توضیحات
id String شناسه Bookmark .

بازگشت

Bookmark - Bookmark با شناسه داده شده، یا اگر چنین Bookmark در برگه وجود نداشته باشد null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

همه اشیاء Bookmark در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت همه نشانک‌ها در هر برگه، از روش DocumentTab.getBookmarks() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

بازگشت

Bookmark[] - آرایه ای از اشیاء Bookmark در برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getCursor()

نشانگر کاربر را در برگه فعال دریافت می کند. یک اسکریپت فقط می‌تواند به مکان‌نمای کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

بازگشت

Position - نمایشی از مکان نما کاربر، یا اگر کاربر مکان نما را در برگه قرار ندهد یا اسکریپت به سند محدود نشده باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getEditors()

لیست ویرایشگران این Document را دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز ویرایش.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

بخش پاورقی برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش پاورقی برگه فعال را بازیابی می کند. برای دریافت قسمت فوتر هر برگه، از متد DocumentTab.getFooter() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

بازگشت

FooterSection - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

تمام عناصر Footnote در بدنه اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، بدنه برگه فعال را بازیابی می کند. برای دریافت تمام پاورقی ها در هر برگه، از روش DocumentTab.getFootnotes() استفاده کنید.

تماس‌های getFootnotes باعث تکرار روی عناصر برگه می‌شوند. برای برگه های بزرگ، از تماس های غیر ضروری به این روش خودداری کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

بازگشت

Footnote[] - پاورقی های برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

بخش هدر برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش سربرگ برگه فعال را بازیابی می کند. برای دریافت بخش هدر هر برگه، از متد DocumentTab.getHeader() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

بازگشت

HeaderSection - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

شناسه منحصر به فرد سند را بازیابی می کند. شناسه سند با DocumentApp.openById() برای باز کردن یک نمونه سند خاص استفاده می شود.

بازگشت

String - شناسه سند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLanguage()

کد زبان سند را دریافت می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد.

بازگشت

String - زبان سند، یا اگر تعریف نشده باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

عنوان سند را بازیابی می کند.

بازگشت

String - عنوان سند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

NamedRange با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت NamedRange با شناسه داده شده در هر برگه، از روش DocumentTab.getNamedRangeById(id) استفاده کنید. اگر چنین NamedRange در برگه وجود نداشته باشد، این متد null را برمی‌گرداند. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک برگه ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

پارامترها

نام تایپ کنید توضیحات
id String شناسه محدوده، که در برگه منحصر به فرد است.

بازگشت

NamedRange - NamedRange با شناسه داده شده، یا اگر چنین محدوده ای در برگه وجود نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

تمام اشیاء NamedRange را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت تمام اشیاء NamedRange در هر برگه، از متد DocumentTab.getNamedRanges() استفاده کنید.

یک NamedRange با هر اسکریپتی که به برگه دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

بازگشت

NamedRange[] - آرایه ای از اشیاء NamedRange در برگه، احتمالاً شامل چندین محدوده با یک نام است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

تمام اشیاء NamedRange را با نام داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت تمام اشیاء NamedRange در هر برگه، از روش DocumentTab.getNamedRanges(name) استفاده کنید. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک برگه ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

یک NamedRange با هر اسکریپتی که به سند دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لزوما منحصر به فرد نیست.

بازگشت

NamedRange[] - آرایه ای از اشیاء NamedRange در برگه با نام داده شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

انتخاب کاربر را در برگه فعال دریافت می کند. یک اسکریپت فقط می‌تواند به انتخاب کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

بازگشت

Range - نمایشی از انتخاب کاربر، یا null کاربر چیزی را در برگه انتخاب نکرده باشد، اگر فقط انتهای یک پاراگراف انتخاب شده باشد، اگر فقط انتهای یک پاراگراف و یک خط جدید انتخاب شده باشد، یا اگر اسکریپت به سند محدود نمی شود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSupportedLanguageCodes()

همه کدهای زبانی که در فایل‌های Google Docs پشتیبانی می‌شوند را دریافت می‌کند.

بازگشت

String[] - آرایه ای از کدهای زبان.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTab(tabId)

Tab با شناسه مشخص شده دریافت می کند. اگر چنین Tab وجود نداشته باشد، این متد null را برمی‌گرداند. می تواند به برگه ها در هر سطح تودرتو دسترسی داشته باشد.

پارامترها

نام تایپ کنید توضیحات
tabId String شناسه برگه برای دریافت.

بازگشت

Tab - Tab با شناسه مشخص شده، یا اگر چنین Tab وجود نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

همه Tab تودرتو نشده را که بخشی از سند هستند دریافت می کند.

برگه‌ها می‌توانند حاوی برگه‌های فرزند باشند، یک برگه تودرتو در یک برگه دیگر. برگه های فرزند با استفاده از Tab.getChildTabs() قابل دسترسی هستند.

بازگشت

Tab[] - لیست تمام Tab هایی که بخشی از سند هستند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

URL را برای دسترسی به سند فعلی بازیابی می کند. 

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

بازگشت

String - URL برای دسترسی به سند فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز مشاهده یا نظر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص در برگه اول یا، برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال است. برای ایجاد یک Position نسبت به یک مکان در هر برگه، از روش DocumentTab.newPosition(element, offset) استفاده کنید. مکان‌نمای کاربر در میان سایر کاربردها به‌عنوان یک Position نمایش داده می‌شود. 

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

پارامترها

نام تایپ کنید توضیحات
element Element عنصری که باید حاوی Position جدید باشد. این باید یا یک عنصر Text یا یک عنصر ظرف مانند Paragraph باشد.
offset Integer برای عناصر Text ، تعداد کاراکترهای قبل از Position . برای سایر عناصر، تعداد عناصر فرزند قبل از Position در همان عنصر ظرف.

بازگشت

Position - Position جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه در اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، از برگه فعال استفاده می شود. برای ایجاد سازنده ای که برای ساخت اشیاء DocumentRange از عناصر برگه در هر برگه استفاده می شود، از متد DocumentTab.newRange() استفاده کنید. 

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

بازگشت

RangeBuilder - سازنده جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document را مسدود نمی‌کند - برای مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای حذف.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document را مسدود نمی‌کند - برای مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای حذف.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده یا نظردهنده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document را مسدود نمی‌کند - به عنوان مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای حذف.

بازگشت

Document - این Document برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document را مسدود نمی‌کند - به عنوان مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای حذف.

بازگشت

Document - این Document برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

Document فعلی را ذخیره می کند. باعث می شود که به روز رسانی های معلق پاک و اعمال شوند.

متد saveAndClose() به طور خودکار در پایان اجرای اسکریپت برای هر Document قابل ویرایش باز فراخوانی می شود.

یک Document بسته قابل ویرایش نیست. از DocumentApp.openById() برای باز کردن مجدد یک سند معین برای ویرایش استفاده کنید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setActiveTab(tabId)

Tab انتخاب شده کاربر در سند فعلی را به برگه با شناسه مشخص شده تنظیم می کند. 

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

پارامترها

نام تایپ کنید توضیحات
tabId String شناسه برگه برای تنظیم به عنوان فعال.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

مکان نما کاربر را با یک Position تعیین می کند. یک اسکریپت فقط می‌تواند به مکان‌نمای کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.

ارائه یک Position از یک Tab غیرفعال، برگه فعال کاربر را تغییر می دهد. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

پارامترها

نام تایپ کنید توضیحات
position Position مکان مکان نما جدید

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

کد زبان سند را تنظیم می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد. از getSupportedLanguageCodes() برای دریافت همه کدهای زبان معتبر استفاده کنید.

پارامترها

نام تایپ کنید توضیحات
languageCode String کد زبان

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

عنوان سند را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
name String عنوان سند جدید

بازگشت

Document - سند فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

انتخاب کاربر را در برگه فعال با توجه به Range تنظیم می کند. یک اسکریپت فقط می‌تواند به انتخاب کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

پارامترها

نام تایپ کنید توضیحات
range Range طیف جدیدی از عناصر برای انتخاب.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents